Crate holochain_trace

source ·
Expand description

§Structured Contextual Logging (or tracing)

§Why

Watch or Read

§Intention of this crate

This crate is designed ot be a place to experiment with ideas around tracing and structured logging. This crate will probably never stabilize. Instead it is my hope to feed any good ideas back into the underlying dependencies.

§Usage

There are a couple of ways to use structured logging.

§Console and filter

If you want to try and filter in on an issue it might be easiest to simply log to the console and filter on what you want. Here’s an example command:

RUST_LOG='core[a{something="foo"}]=debug' my_bin

Or a more simple version using the default Log:

RUST_LOG=trace my_bin
§Types of tracing

There are many types of tracing exposed by this crate. The Output type is designed to be used with something like structopt so you can easily set which type you want with a command line arg. You could also use an environment variable. The Output variant is passing into the init_fmt function on start up.

§Filtering
RUST_LOG='core[a{something="foo"}]=debug'

Here we are saying show me all the events that are:

  • In the core module
  • Inside a span called a
  • The span a has to have a field called something that is equal to foo
  • They are at least debug level.

Most of these options are optional. They can be combined like:

RUST_LOG='[{}]=error,[{something}]=debug'

The above means show me errors from anywhere but also any event or span with the field something that’s at least debug.

See here for more info.

§Json

Sometimes there’s too much data and it’s better to capture it to interact with using another tool later. For this we can output everything as Json using the flag --structured Json. Then you can pipe the output from stdout to you’re file of choice. Here’s some sample output:

{"time":"2020-03-03T08:07:05.910Z","name":"event crates/sim2h/src/sim2h_im_state.rs:695","level":"INFO","target":"sim2h::sim2h_im_state","module_path":"sim2h::sim2h_im_state","file":"crates/sim2h/src/sim2h_im_stat
e.rs","line":695,"fields":{"space_hashes":"[]"},"spans":[{"id":[1099511627778],"name":"check_gossip","level":"INFO","target":"sim2h::sim2h_im_state","module_path":"sim2h::sim2h_im_state","file":"crates/sim2h/src/s
im2h_im_state.rs","line":690}]}

Every log will include the above information expect for the spans which will only show up if there are parent spans in the context of the event.

You can combine filter with Json as well.

§Tools

Some useful tools for formatting and using the json data.

A sample workflow:

RUST_LOG='core[{}]=debug' my_bin --structured Json > log.json
cat out.json | jq '. | {time: .time, name: .name, message: .fields.message, file: .file, line: .line, fields: .fields, spans: .spans}' | json2csv -o log.csv
tad log.csv

Re-exports§

Modules§

Macros§

  • metrics
    Create a metrics set. Takes the name of the metric set followed by a list of metric names.

Enums§

  • Output
    Sets the kind of structured logging output you want

Functions§

  • init_fmt
    This checks RUST_LOG for a filter but doesn’t complain if there is none or it doesn’t parse. It then checks for CUSTOM_FILTER which if set will output an error if it doesn’t parse.
  • test_run
    Run logging in a unit test.
  • test_run_timed
    Same as test_run but with timed spans
  • test_run_timed_flame
    Generate a flamegraph from timed spans of “busy time”.
  • test_run_timed_flame_consoleDeprecated
    Generate a flamegraph from timed spans “busy time”. Takes a path where you are piping the output into. If the path is provided a flamegraph will automatically be generated. TODO: Get auto inferno to work for now use (fish, or the bash equiv): 2>| inferno-flamegraph > flamegraph_test_ice_(date +'%d-%m-%y-%X').svg And run with cargo test --quiet
  • test_run_timed_ice
    Generate a flamegraph from timed spans of “idle time”.
  • test_run_timed_ice_consoleDeprecated
    Generate a flamegraph from timed spans “idle time”. Takes a path where you are piping the output into. If the path is provided a flamegraph will automatically be generated. TODO: Get auto inferno to work for now use (fish, or the bash equiv): 2>| inferno-flamegraph -c blue > flamegraph_test_ice_(date +'%d-%m-%y-%X').svg And run with cargo test --quiet
  • test_run_timed_json
    Same as test_run_timed but saves as json

Type Aliases§